home *** CD-ROM | disk | FTP | other *** search
/ QRZ! Ham Radio 6 / QRZ Ham Radio Callsign Database - Volume 6.iso / pc / files / amiga / vhlogger.lzh / vhlogger.doc < prev    next >
Encoding:
Text File  |  1993-01-22  |  17.5 KB  |  444 lines

  1. #1zz
  2.  
  3.  
  4.  
  5.  
  6.  
  7.           VHLogger
  8.  
  9.                This is version 2.05 (01/22/93) of VHLogger a shareware
  10.           Amateur  radio  logging  program,  Copyright  1990  by Vincent J.
  11.           Herried.
  12.  
  13.           Please refer to the copyright files.
  14.  
  15.           Acknowledgments:
  16.  
  17.           Marcus  J.  Ranum  for  his   btree   routines   (see   the  file
  18.           copyright.btree  for  restrictions  on  his  code or where to get
  19.           your copy) 
  20.  
  21.           Peter Hardie (VE5VA) for his time zone calculation routines.
  22.  
  23.           CHANGES (most recent first)
  24.  
  25.                V2.05 01/22/93 add timezone calculations to automatically
  26.                     adjust for your timezone.   Use  the AmigaDos AddPart()
  27.                     function  to  generate  the  path name for the database
  28.                     name. 
  29.  
  30.                V2.04 12/15/92 if 'find' is  from  AREXX  do  not  flash the
  31.                     screen.
  32.  
  33.                V2.03 07/19/92 cleanup.  Add history panel.
  34.  
  35.                V2.02 07/06/92 (not public ) fix QTH toggle.
  36.  
  37.                V2.01 07/05/92 (not public ) convert to Dos V2.04 look using
  38.                     GadTools.  Power Windows  code removed.   ***  note Use
  39.                     your tab keys to navigate from one entry to another
  40.  
  41.                V1.02 02/26/92
  42.                     Add the REXX port.
  43.  
  44.                V1.01
  45.                     Added reorg utility to de-gas the data base.  Fixed the
  46.                     peculiarity  after  doing  a   'SAVE'  it   forgot  its
  47.                     place in the data base.
  48.  
  49.                V1.00 initial release.
  50.  
  51.           DESCRIPTION
  52.  
  53.                VJHLogger  is  a  ham  radio logging program that uses btree
  54.           algorithms  for  storage  and  retrieval  of  data.    The window
  55.           interface  uses  AmigaDos  Intuition  string and boolean gadgets.
  56.           During program initial development  I used  PowerWidows to define
  57.           the  C  structures  for  all  of  the  components  of  the window
  58.           including the menus.  All of the routine  information for logging
  59.           purposes is provided including a comments section which can store
  60.           information of your  choice.    I  use  it  for  making 'private'
  61. z
  62.  
  63.  
  64.  
  65.  
  66.           comments about the other persons CW proficiency.
  67.           Rather  than  reinvent  the  wheel  I'm  using  the AmigaDos V2.0
  68.           asl.library file requester, the  file asl.library  must either be
  69.           in  your  current  directory  or  in your LIBS: system directory.
  70.           asl.library comes standard with V2.04 of AmigaDos.
  71.  
  72.           EXCUSE
  73.                Please note, this is my first 'real' program  in 'C'  and as
  74.           such it  may not be perfect or elegant, it has, however been beat
  75.           on a fair bit and I'm confident that you will  find it moderately
  76.           bug free  (see list  of known  bugs at the end of this document).
  77.           However I have not done much operating on other than  the VHF/UHF
  78.           bands as  of late  and thus  have not used this program in a live
  79.           logging situation.  I wrote this  as an  exercise, one  because I
  80.           miss my  IBM programming  days and two because I've not seen much
  81.           in the way of Ham radio software for the Amiga.  If you find bugs
  82.           or  have  constructive  suggestions  for  the  next version don't
  83.           hesitate to send them.  Also if you have information about other
  84.           sources of Ham related software for  the Amiga,  I would  like to
  85.           hear about  them.  If you feel this worthy program then send me a
  86.           donation (about $10.00) and  you will  become a  registered owner
  87.           and will  become authorized  to send  me your complaints about my
  88.           code, my in-laws or anything else that suits you.
  89.  
  90.           TIMEZONE support (New with V2.05) :
  91.             
  92.           Setting your offset from GMT:   The code  that supports  the time
  93.           zone offset was provided compliments of Peter Hardie (VE5VA).  If
  94.           it works, thank Peter, if it doesn't blame me.
  95.  
  96.           You will probably wish  to keep  track of  the date  and time and
  97.           store it  in each  log entry.  The current time is also displayed
  98.           on top of the screen. Just before you start you should first     
  99.           ensure that   your clock  is set  to the  correct time  (local or
  100.           UTC) by synchronizing it to one  of  the  time  services  such as
  101.           WWV.   If your  computer time is local time and not UTC, then you
  102.           must also tell the computer about your local time zone.  This can
  103.           be done  using a setenv command to specify your local timezone as
  104.           hours  (and  optionally   minutes)   west   (positive)   or  east
  105.           (negative) of Greenwich.
  106.  
  107.           The  program  also  handles daylight savings time(DST) conversion
  108.           and this must be specified in the same setenv call if it  applies
  109.           in    your  area.  Finally,  if  your timezone uses DST, then the
  110.           program also needs to  know whether  you are  in the  northern or
  111.           southern  hemisphere  and  you  encode this bit of information by
  112.           specifying the DST indicator  in lower  (North) or  upper (South)
  113.           case.  The general format of the command is:
  114.  
  115.                setenv [-]hh[:mm][D]
  116.  
  117.           This means  that the time is specified as a number of hours which
  118.           can  be  preceded  by  an  optional  minus  sign  (for  EAST) and
  119.           optionally  followed  by  a  number  of  minutes  (e.g.  3:30 for
  120. z
  121.  
  122.  
  123.  
  124.  
  125.           Newfoundland) and all of this can  have an  optional letter after
  126.           it to  specify that  your timezone  uses daylight  savings time. 
  127.           The dates of the start and  end of  DST are  different in various
  128.           parts of  the world.   You indicate which is used in your zone by
  129.           one of the  following  letters.    If  you  are  in  the northern
  130.           hemisphere then you must specify the letter in lower case, and if
  131.           you are in the southern hemisphere  then you  must specify  it in
  132.           upper case.   The  letters and  the dates of the start and end of
  133.           DST are listed below:
  134.  
  135.  
  136.                d or D:   North America. Start first Sunday in April and end
  137.                          last Sunday in October.
  138.  
  139.                u or U:   U.K.   Start   last   Sunday in March and end last
  140.                          Sunday in October  (approximately!  -  the precise
  141.                          dates are set  by act of parliament each year).
  142.  
  143.  
  144.                e or E:   Europe.   Start last  Sunday in March and end last
  145.                          Sunday in September.
  146.  
  147.                c or C:   China(!). Start 12th April and end 12th September.
  148.  
  149.           If you specify upper  case for  the southern  hemisphere then the
  150.           start and  end of  DST are  reversed. In  all cases the start and
  151.           end occur at 2am. 
  152.  
  153.           The best thing to do is to add a setenv command in your
  154.           s:user_startup If you use  any of  Peter's programs,  such as the
  155.           CBBS packet  program or  the CHU program, then you won't  have to
  156.           do anything extra with them if  you  use  setenv  TZ_CHU  in your
  157.           startup file because they all use the same routine to check for
  158.           your timezone and adjust to UTC. Peter uses the command:
  159.  
  160.                setenv TZ_CHU 6
  161.  
  162.           in  his    s:startup-sequence  file  because he is in the Central
  163.           Standard Time zone (6 hours west of Greenwich) and they don't use
  164.           DST.    In  Germany,  which  is  one  hour  ahead of UTC and uses
  165.           European daylight savings time you would use:
  166.  
  167.                setenv TZ_CHU -1e
  168.  
  169.           I'm in the heart  of Ohio  Eastern Standard  Time Zone,  (5 hours
  170.           west of Greenwich) and I use:
  171.  
  172.                setenv TZ_CHU  5d
  173.  
  174.  
  175.           I am  not sure  what DST  is used in Australia or New Zealand but
  176.           if, as an example,  they use  the same  DST as  the U.K.  then an
  177.           Upper case  'U' is  specified along with the timezone correction.
  178.           If you wish to send me a note,  I'll make  adjustments for  in my
  179. z
  180.  
  181.  
  182.  
  183.  
  184.           code and  if you  write the note on the back of a US $10.00 bill,
  185.           I'll even send you a new copy :-)
  186.  
  187.  
  188.  
  189.           FUNCTIONS
  190.                 VHLogger will create a  Database  consisting  of  two files
  191.                with the suffixes of .ndx and .dat.
  192.  
  193.                 One can then add, delete, update, and display records from
  194.                 this data base.
  195.  
  196.              FIRST
  197.                 Positions you to the first record in the data base.
  198.  
  199.              NEXT
  200.                 Goes to the next record in alphabetical order.
  201.  
  202.              LAST
  203.                 Goes the last record of the data base.
  204.  
  205.              PREV
  206.                 Goes to the previous record.
  207.  
  208.              FIND
  209.                 This function searches the data base for the entry in the
  210.                 "call sign" field.
  211.  
  212.              HISTORY
  213.                 New  for  V2.    This  panel will display the last 500 call
  214.           signs
  215.                 that you have retrieved.     You may scroll the list up and
  216.           down
  217.                 with the arrows or the scroll bar.  Clicking on an entry
  218.                 does a FIND on that call sign.
  219.  
  220.              SAVE
  221.                 This function saves the displayed data into the data base.
  222.                 The call sign field is converted to uppercase but the other
  223.           text
  224.                 fields are unmodified.
  225.  
  226.              DEL
  227.                 This function  deletes the  record and  key associated with
  228.           the
  229.                 contents of the "call sign" field.
  230.  
  231.           Menu functions
  232.  
  233.              OPEN
  234.                This function  uses the asl.library file requestor to select
  235.                a data base file name and then open  it.   If the  data base
  236.                did not  exist then a new one will be created.  Note that if
  237.                you select a file name that ends in either ".ndx"  or ".dat"
  238. z
  239.  
  240.  
  241.  
  242.  
  243.                these suffixes  are removed from the name before opening the
  244.                data base.  This is done because the data base consists of
  245.                an index file with the suffix .ndx and a data  file with the
  246.                suffix  of  .dat.    By  removing your .dat or .ndx from the
  247.                selection I prevent files  with names  like data  ndx.ndx or
  248.                log.ndx.dat which  might confuse  some folks.  Both the .ndx
  249.                and .dat files must be located in the same directory.
  250.  
  251.              CLOSE
  252.                This function is used if one should wish  to close  one data
  253.                file and  open another  without ending  the program.  If you
  254.                select END, then the close function  is automatically called
  255.                before the program ends.
  256.  
  257.              END
  258.                Closes the files and terminates the program.
  259.  
  260.              ABOUT
  261.                Displays the version number and copyright statement.
  262.  
  263.              PREFS
  264.                Sets your  offset from  GMT so that you can use the built in
  265.                Amiga clock to set the start  and end  times when  logging a
  266.                contact.
  267.  
  268.           Entering data
  269.  
  270.                The string  gadgets can be navigated by using the tab key or
  271.                the shift and the tab key.
  272.  
  273.           Description of data fields
  274.  
  275.                Date
  276.                By entering <right Amiga s> the current date  is placed into
  277.                this  string  gadget.    This  is  the  starting date of the
  278.                contact.  Note that this date  is  based  on  the  GMT time.
  279.                Some of us forget to change the date when the time goes past
  280.                midnight GMT, don't let you be one of them.
  281.  
  282.              Start time
  283.                By entering <right Amiga s> the  current time  offset by the
  284.                number of hours from GMT is stored in this string gadget.
  285.  
  286.              E time
  287.                By entering  <right Amiga  p> the current time offset by the
  288.                number of hours from GMT is stored in this string gadget.
  289.  
  290.              Call Sign
  291.                There is room here  for up  to 10  characters.   This is the
  292.                "key" against which all data base operations are performed.
  293.  
  294.              NAME
  295.                 This string gadget is intended to contain the callers name.
  296.  
  297. z
  298.  
  299.  
  300.  
  301.  
  302.              RSTS
  303.                sent "Readability Signal strength Tone"
  304.  
  305.                R a  digit from  1 to  5 indicating how readable the contact
  306.                signal was.
  307.                1 unreadable, 
  308.                2 barely readable, occasional words distinguishable,
  309.                3 readable with considerable difficulty, 
  310.                4 readable with practically no difficulty, 
  311.                5 perfectly readable.
  312.  
  313.                S a  digit  from  1  to  9  indicating  the  relative signal
  314.                strength of the received signal.
  315.                1 faint signals, barely perceptible, 
  316.                2 very weak signals, 
  317.                3 weak signal, 
  318.                4 fair signals, 
  319.                5 fairly good signals,
  320.                6 good signals, 
  321.                7 moderately strong signals, 
  322.                8 strong signals
  323.                9 extremely strong signals,
  324.  
  325.                T a  digit from  1 to 9 indicating the purity of the tone of
  326.                the received CW. 
  327.                1 sixty cycle ac, very broad and rough, 
  328.                2 very rough ac, very harsh and broad, 
  329.                3 rough ac tone, rectified but not filtered
  330.                4 rough note, some trace of filtering, 
  331.                5 filtered rectified ac, but strongly ripple modulated, 
  332.                6 filtered tone, definite trace of ripple modulation, 
  333.                7 near pure tone, trace of ripple modulation
  334.                8 near perfect tone, slight trace of ripple modulation,
  335.                9 perfect tone, no  trace of  ripple or  modulation of  any 
  336.           kind.
  337.  
  338.                Note, some  cw ops  also optionally  add a 'c' at the end to
  339.                indicate the presence  of  'click'.    This  release doesn't
  340.                support this  extra character,  if you need it,put it in the
  341.                comments field.
  342.  
  343.              RSTR
  344.                received "Readability Signal strength  Tone"  Enter  the RST
  345.                that the other station sends to you.
  346.  
  347.              QTH
  348.                Turn  on  the  check-mark  with  a mouse click if you worked
  349.                this station from your permanent station  location (home qth
  350.                in CW speak).  note that the rexx exec was.rexx interrogates
  351.                this flag.  The worked all states award requires you to make
  352.                the contacts from your 'QTH'
  353.  
  354.              Address
  355.                Save the other station's address here
  356. z
  357.  
  358.  
  359.  
  360.  
  361.  
  362.              City
  363.                Save the other station's city here.
  364.  
  365.              State
  366.                Save  the  other  station's  state  or  providence here.  If
  367.                you're into DX you may stuff in a country code here.
  368.  
  369.              zip
  370.                Save the other station's zip code here.
  371.  
  372.              MODE
  373.                Click your  mouse here  to select  the appropriate operating
  374.                mode.
  375.  
  376.              Pwer
  377.                Click your mouse here to select your transmitter power.
  378.  
  379.              Band
  380.                Click your mouse here to select your operating band.
  381.  
  382.              Ant
  383.                Click your mouse here to select your antenna.
  384.  
  385.              QSL
  386.                Click your mouse here to change the display from:
  387.                QSL? -  to indicate  that a  QSL card  has not been sent nor
  388.                received.
  389.  
  390.                QSLS - indicates a QSL card has been sent but NOT received.
  391.  
  392.                QSLR - indicates a QSL card has been received but NOT sent.
  393.  
  394.                QSL - indicates a QSL card has been received and sent.
  395.  
  396.           TODO
  397.  
  398.  
  399.           1.   Allow printing of log entries.  While a desirable goal, with
  400.                AREXX one  may easily  print your log entrys.  They will not
  401.                in chronological order.
  402.  
  403.           2.   The above implies adding an additional key based on date and
  404.                time.  Maybe in version 3?
  405.  
  406.           3.   Support DX operators (not me, I don't work no steenking DX).
  407.                Maybe if enough hams send money?
  408.  
  409.           4.   Add a TENTEN field?
  410.  
  411.           5.   Support searches on other fields and support wild cards.
  412.  
  413.           6.   Support user customizing of the "names" of the antennas.
  414.                One  could  zap  them  but  be  careful,  these  fields  may
  415. z
  416.  
  417.  
  418.  
  419.  
  420.                change in the next  release and  you may  have problems with
  421.                some  incompatible  data.    If you feel comfortable writing
  422.                Arexx execs, you could fixed it tho.
  423.  
  424.           7.   Change the error messages  and confirmation  messages to not
  425.                use  requesters.    The  error  messages  should not require
  426.                mouse confirmation unless the error is very severe.
  427.  
  428.           8.   Add confirmation messages for such things as the  delete and
  429.                store operations.
  430.  
  431.           9.   Other features?   Send me some money and some mail with your
  432.                list of requirements.
  433.  
  434.           BUGS
  435.  
  436.           1.   The ARexx  port doesn't  seem to  fully close  the port when
  437.           vhlogger  is  stopped.    Thus  you  can't  reliably determine if
  438.           vhlogger is running with the ARexx command WaitHost.  If there is
  439.           a next  release it  will probably  replace the REXX interface and
  440.           fix this problem.
  441.  
  442.  
  443.           I would like to hear your feedback.   Feel free  to send comments
  444.           to:
  445.  
  446.           Vincent J. Herried (KA8CTE)
  447.           1688 Staffordshire RD.
  448.           Columbus, OH 43229-2142
  449.           USA
  450.  
  451.  
  452. c